// -*- mode:c++ -*-

// Copyright (c) 2015 RISC-V Foundation
// Copyright (c) 2017 The University of Virginia
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met: redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer;
// redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution;
// neither the name of the copyright holders nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: Robert Scheffel

def format CR32Op(code, *opt_flags) {{
    iop = InstObjParams(name, Name, 'CompRegOp', code, opt_flags)
    header_output = Basic32Declare.subst(iop)
    decoder_output = Basic32Constructor.subst(iop)
    decode_block = Basic32Decode.subst(iop)
    exec_output = Basic32Execute.subst(iop)
}};

def format CI32Op(imm_code, code, imm_type='int32_t', *opt_flags) {{
    regs = ['_destRegIdx[0]','_srcRegIdx[0]']
    iop = InstObjParams(name, Name, 'ImmOp<%s>' % imm_type,
        {'code': code, 'imm_code': imm_code,
         'regs': ','.join(regs)}, opt_flags)
    header_output = Imm32Declare.subst(iop)
    decoder_output = Imm32Constructor.subst(iop)
    decode_block = Basic32Decode.subst(iop)
    exec_output = Imm32Execute.subst(iop)
}};

def format CB32Op(code, *opt_flags) {{
    imm_code = '''
               imm = CIMM5<2:1> << 1 |
                     CIMM3<1:0> << 3 |
                     CIMM5<0:0> << 5 |
                     CIMM5<4:3> << 6;
               if (CIMM3<2:2> > 0)
                    imm |= ~((int32_t)0xff);
               '''
    regs = ['_srcRegIdx[0]','_srcRegIdx[1]']
    iop = InstObjParams(name, Name, 'ImmOp<int32_t>',
        {'code': code, 'imm_code': imm_code,
         'regs': ','.join(regs)}, opt_flags)
    header_output = Branch32Declare.subst(iop)
    decoder_output = Imm32Constructor.subst(iop)
    decode_block = Basic32Decode.subst(iop)
    exec_output = Branch32Execute.subst(iop)
}};

def format CompressedLoad32(ldisp_code, memacc_code,
        ea_code, mem_flags=[], inst_flags=[]) {{
    (header_output, decoder_output, decode_block, exec_output) = \
        LoadStore32Base(name, Name, ldisp_code, ea_code, memacc_code,
            mem_flags, inst_flags, 'Load', exec_template_base='Load32')
}};

def format CompressedStore32(sdisp_code, memacc_code,
        ea_code, mem_flags=[], inst_flags=[]) {{
    (header_output, decoder_output, decode_block, exec_output) = \
        LoadStore32Base(name, Name, sdisp_code, ea_code, memacc_code,
            mem_flags, inst_flags, 'Store', exec_template_base='Store32')
}};
